Add sshdconfig _purge=false support for regular keywords #1348
+471
−198
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR renames the _clobber parameter to _purge and implements support for _purge=false to preserve existing SSH daemon configuration settings while updating specific keywords. The implementation refactors configuration writing into a dedicated helper function and adds comprehensive test coverage for various set scenarios.
Changes:
- Renamed
_clobberto_purgeacross all files for clearer semantics - Implemented
_purge=falsesupport for regular (non-repeatable, non-multi-value) keywords - Refactored config file writing logic by extracting
write_config_map_to_text()helper function
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| resources/sshdconfig/tests/sshdconfig.set.tests.ps1 | Updated all test cases to use _purge instead of _clobber; added comprehensive test cases for _purge=false scenarios including file existence checks, multi-value keyword restrictions, and various keyword update/preserve/remove operations |
| resources/sshdconfig/tests/sshdconfig.get.tests.ps1 | Added test case for handling non-existent config files |
| resources/sshdconfig/src/util.rs | Refactored format_sshd_value() to be private; changed format_value_as_string() to return String instead of Result; added write_config_map_to_text() helper function; added file existence check in invoke_sshd_config_validation(); updated error handling to use new FileNotFound error type |
| resources/sshdconfig/src/set.rs | Implemented _purge=false logic that retrieves existing config, validates keywords are not repeatable/multi-value, and merges changes; updated to use new write_config_map_to_text() helper |
| resources/sshdconfig/src/inputs.rs | Renamed clobber field to purge in CommandInfo struct |
| resources/sshdconfig/src/error.rs | Added new FileNotFound error variant |
| resources/sshdconfig/locales/en-us.toml | Updated error messages: removed clobberFalseUnsupported, added fileNotFound, purgeFalseRequiresExistingFile, and purgeFalseUnsupported |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
SteveL-MSFT
requested changes
Jan 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
SteveL-MSFT
requested changes
Jan 14, 2026
SteveL-MSFT
approved these changes
Jan 14, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
clobbertopurgein various locationssetsupport with_purge: falsefor regular keywordsset_sshd_config()by creatingwrite_config_map_to_text(), a helper function in util.rs_purge: truebut will result in an error for_purge: falsesince there would be no existing settings to preserve